/*
**************************************************************************************
*Myriad Engine                                                                       *
*Copyright (C) 2006-2007, 5d Studios (www.5d-Studios.com)                            *
*                                                                                    *
*This library is free software; you can redistribute it and/or                       *
*modify it under the terms of the GNU Lesser General Public                          *
*License as published by the Free Software Foundation; either                        *
*version 2.1 of the License, or (at your option) any later version.                  *
*                                                                                    *
*This library is distributed in the hope that it will be useful,                     *
*but WITHOUT ANY WARRANTY; without even the implied warranty of                      *
*MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU                   *
*Lesser General Public License for more details.                                     *
*                                                                                    *
*You should have received a copy of the GNU Lesser General Public                    *
*License along with this library; if not, write to the Free Software                 *
*Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA      *
**************************************************************************************
*/
package leola.types;


/**
 * Leola boolean value
 * 
 * @author Tony
 *
 */
public class LeoBoolean extends LeoObject {

	/**
	 * True
	 */
	public static final LeoBoolean LEOTRUE = new LeoBoolean(true);
	
	/**
	 * False
	 */
	public static final LeoBoolean LEOFALSE = new LeoBoolean(false);
	
	/*
	 * Value
	 */
	private boolean value;
	
	/**
	 * @param type
	 */
	private LeoBoolean(boolean value) {
		super(LeoType.BOOLEAN);
		this.value = value;
	}
	
	/**
	 * @return true if this is an instance of True
	 */
	public boolean isTrue() {
		return this.value;
	}
	
	/**
	 * @return true if this is an instance of False
	 */
	public boolean isFalse() {
		return ! this.value;
	}

	/**
	 * Gets the instance of the boolean.
	 * 
	 * @param value
	 * @return
	 */
	public static LeoBoolean get(boolean value) {
		return value ? LEOTRUE : LEOFALSE;
	}
	
	/* (non-Javadoc)
	 * @see leola.types.LeoObject#toString()
	 */
	@Override
	public String toString() {
		return Boolean.toString(this.value);
	}

	/* (non-Javadoc)
	 * @see leola.types.LeoObject#eq(leola.types.LeoObject)
	 */
	@Override
	public boolean eq(LeoObject other) {		
		return (other != null) && (other.isTrue() == this.isTrue());
	}

	/* (non-Javadoc)
	 * @see leola.types.LeoObject#gt(leola.types.LeoObject)
	 */
	@Override
	public boolean gt(LeoObject other) {
		return false;
	}

	/* (non-Javadoc)
	 * @see leola.types.LeoObject#lt(leola.types.LeoObject)
	 */
	@Override
	public boolean lt(LeoObject other) {
		return false;
	}

	/* (non-Javadoc)
	 * @see leola.types.LeoObject#getValue()
	 */
	@Override
	public Object getValue() {
		return this.isTrue();
	}
	
	/* (non-Javadoc)
	 * @see leola.types.LeoObject#clone()
	 */
	@Override
	public LeoObject clone() {
		return this;
	}
}
